home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / __SETCOL.HDR < prev    next >
Text File  |  1994-04-25  |  3KB  |  98 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _SetColor( nColorArea, cNewColor ) --> cOldSetting
  8.  
  9. PARAMETERS:
  10.  
  11. PARAMETERS: nColorArea    : Color Area
  12. cNewColor : New Color Setting Value
  13.  
  14. SHORT:
  15.  
  16. Set individual color settings without affecting others in the
  17. scheme.
  18.  
  19. DESCRIPTION:
  20.  
  21. DESCRIPTION: _SetColor() works identically to Clipper's SETCOLOR()
  22. function with the singular exception that it works on individual color
  23. "areas" independently from the rest.  That is, you can set the
  24. Standard, Enhanced, and Unselected foreground and background colors
  25. without affecting or needing to know the settings of the others.
  26.  
  27. If cNewColor is not specified, the function simply returns the current
  28. area color setting.
  29.  
  30. The individual color areas are selected by the following numerical orders:
  31.  
  32. 1    Standard Foreground Color
  33. 2    Standard Background Color
  34.  
  35. 3    Enhanced Foreground Color
  36. 4    Enhanced Background Color
  37.  
  38. 5    Unselected Foreground Color
  39. 6    Unselected Background Color
  40.  
  41. Use the following #define statements in your application for clarity:
  42.  
  43. #define STANDARD_FORE  1
  44. #define STANDARD_BACK  2
  45. #define ENHANCED_FORE  3
  46. #define ENHANCED_BACK  4
  47. #define UNSELECT_FORE  5
  48. #define UNSELECT_BACK  6
  49.  
  50. cNewColor valid values are:
  51.  
  52. n     BLACK
  53. b     BLUE
  54. g     GREEN
  55. bg    CYAN
  56. r     RED
  57. rb    NAGENTA
  58. gr    BROWN / YELLOW
  59. w     WHITE
  60. u     UNDERLINE           (MONO)
  61. i     INVERSE             (MONO)
  62. x     BLANK (NON-DISPLAY) (MONO)
  63.  
  64. _SetColor() can, for example, alter the standard foreground color without
  65. changing or needing to know the standard background color.
  66.  
  67. NOTE:
  68.  
  69. Background and Border settings are not supported.  On some VGA cards and
  70. monitors, the BACKGROUND color, which is supposedly not supported by Clipper,
  71. actually sets the color of a small border. In any case, it is not supported
  72. by Klipper's _SetColor().
  73.  
  74. EXAMPLE:
  75.  
  76. SET COLOR TO w+/b,g+/n
  77.  
  78. t = _SetColor(STANDARD_FORE,'w+*')
  79.  
  80. Result: The standard foreground color is changed to high-white-blinking,
  81. the other color settings remain unchanged, and the function returns "W+"
  82.  
  83. t = _SetColor(ENHANCED_BACK,'b')
  84.  
  85. Result: The enhanced background color is changed to blue, the other
  86. color settings remain unchanged, and the function returns "N"
  87.  
  88. t = _SetColor(UNSELECT_BACK)
  89.  
  90. Result: The unselected background color is left unchanged and and the
  91. function returns "N"
  92.  
  93.  
  94.  
  95.  
  96.  
  97. ******************************************************************************/
  98.